/*
 *  Hamlib CI-V backend - description of the TenTenc OMNI VI
 *  Copyright (c) 2000-2010 by Stephane Fillod
 *
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Lesser General Public
 *   License as published by the Free Software Foundation; either
 *   version 2.1 of the License, or (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *   Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

/* Improvements by Martin Ewing, AA6E, 3/2008
 * This backend should support either the Ten-Tec Omni VI Plus (564) or the
 * Omni VI (563).  Tested on an Omni VI.
 */

/* Known problems:
 *
 * To Do:
 *  Implement vfo split, FSK mode
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdlib.h>

#include <hamlib/rig.h>
#include "icom.h"
#include "icom_defs.h"
#include "frame.h"
#include <misc.h>

#define OMNIVIP_VFO_ALL (RIG_VFO_A|RIG_VFO_B|RIG_VFO_MEM)

#define OMNIVIP_OTHER_TX_MODES (RIG_MODE_CW|RIG_MODE_SSB|RIG_MODE_FM)

#define OMNIVIP_ALL_RX_MODES (OMNIVIP_OTHER_TX_MODES)

#define OMNIVIP_VFO_OPS (RIG_OP_FROM_VFO|RIG_OP_TO_VFO)
#define OMNIVIP_STR_CAL { 0, { } }

static int omni6_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt);
static int omni6_set_rit(RIG *rig, vfo_t vfo, shortfreq_t rit);
static int omni6_get_rit(RIG *rig, vfo_t vfo, shortfreq_t *rit);

static const struct icom_priv_caps omnivip_priv_caps = {
		0x04,	/* default address */
		0,		/* 731 mode */
		NULL    /* TODO */
};

const struct rig_caps omnivip_caps = {
.rig_model =  RIG_MODEL_OMNIVIP,
.model_name = "Omni VI Plus",
.mfg_name =  "Ten-Tec",
.version =  "0.2",
.copyright =  "LGPL",
.status =  RIG_STATUS_BETA,
.rig_type =  RIG_TYPE_TRANSCEIVER,
.ptt_type =  RIG_PTT_RIG,           // Allow program controlled PTT
.dcd_type =  RIG_DCD_NONE,
.port_type =  RIG_PORT_SERIAL,
.serial_rate_min =  1200,
.serial_rate_max =  19200,
.serial_data_bits =  8,
.serial_stop_bits =  1,
.serial_parity =  RIG_PARITY_NONE,
.serial_handshake =  RIG_HANDSHAKE_NONE,
.write_delay =  0,
.post_write_delay =  0,
.timeout =  200,
.retry =  3,
.has_get_func =  RIG_FUNC_NONE,
.has_set_func =  RIG_FUNC_NONE,
.has_get_level =  RIG_LEVEL_NONE,
.has_set_level =  RIG_LEVEL_NONE,
.has_get_parm =  RIG_PARM_NONE,
.has_set_parm =  RIG_PARM_NONE,
.level_gran =  {},
.parm_gran =  {},
.preamp =   { RIG_DBLST_END, },
.attenuator =   { RIG_DBLST_END, },
.max_rit =  Hz(9980),
.max_xit =  Hz(0),
.max_ifshift =  Hz(0),
.targetable_vfo =  0,
.vfo_ops =  OMNIVIP_VFO_OPS,
.scan_ops =  RIG_SCAN_NONE,
.transceive =  RIG_TRN_RIG,
.bank_qty =   0,
.chan_desc_sz =  0,
.chan_list =  { { 0, 99, RIG_MTYPE_MEM, IC_MIN_MEM_CAP },
                RIG_CHAN_END, },
.rx_range_list1 =   {
	RIG_FRNG_END, },
.tx_range_list1 =  { RIG_FRNG_END, },

/* These limits measured on Omni VI SN 1A10473 */
.rx_range_list2 =   {
    {kHz(1770),kHz(2330),OMNIVIP_ALL_RX_MODES,-1,-1,OMNIVIP_VFO_ALL},
    {kHz(3471),kHz(4030),OMNIVIP_ALL_RX_MODES,-1,-1,OMNIVIP_VFO_ALL},
    {kHz(6821),kHz(7338),OMNIVIP_ALL_RX_MODES,-1,-1,OMNIVIP_VFO_ALL},
    {kHz(9971),kHz(10530),OMNIVIP_ALL_RX_MODES,-1,-1,OMNIVIP_VFO_ALL},
    {kHz(13971),kHz(14530),OMNIVIP_ALL_RX_MODES,-1,-1,OMNIVIP_VFO_ALL},
    {kHz(17971),kHz(18530),OMNIVIP_ALL_RX_MODES,-1,-1,OMNIVIP_VFO_ALL},
    {kHz(20971),kHz(21530),OMNIVIP_ALL_RX_MODES,-1,-1,OMNIVIP_VFO_ALL},
    {kHz(24471),kHz(25030),OMNIVIP_ALL_RX_MODES,-1,-1,OMNIVIP_VFO_ALL},
    {kHz(27971),kHz(30030),OMNIVIP_ALL_RX_MODES,-1,-1,OMNIVIP_VFO_ALL},
	RIG_FRNG_END, },

/* Note: There is no AM mode. */
.tx_range_list2 =  {
    {kHz(1800),MHz(2)-1,OMNIVIP_OTHER_TX_MODES,5000,100000,OMNIVIP_VFO_ALL},
    {kHz(3500),MHz(4)-1,OMNIVIP_OTHER_TX_MODES,5000,100000,OMNIVIP_VFO_ALL},
	{MHz(7),kHz(7300),OMNIVIP_OTHER_TX_MODES,5000,100000,OMNIVIP_VFO_ALL},
    {kHz(10100),kHz(10150),OMNIVIP_OTHER_TX_MODES,5000,100000,OMNIVIP_VFO_ALL},
    {MHz(14),kHz(14350),OMNIVIP_OTHER_TX_MODES,5000,100000,OMNIVIP_VFO_ALL},
    {kHz(18068),kHz(18168),OMNIVIP_OTHER_TX_MODES,5000,100000,OMNIVIP_VFO_ALL},
    {MHz(21),kHz(21450),OMNIVIP_OTHER_TX_MODES,5000,100000,OMNIVIP_VFO_ALL},
    {kHz(24890),kHz(24990),OMNIVIP_OTHER_TX_MODES,5000,100000,OMNIVIP_VFO_ALL},
    {MHz(28),kHz(29700),OMNIVIP_OTHER_TX_MODES,5000,100000,OMNIVIP_VFO_ALL},
	RIG_FRNG_END, },

.tuning_steps = 	{
	 {OMNIVIP_ALL_RX_MODES, Hz(10)},        // This radio has 10 Hz steps.
	 RIG_TS_END,
	},
	/* mode/filter list, remember: order matters!
	 * Possible XTAL filters: 2.4, 1.8, 0.5, 0.25 kHz - may not all be
	 * present.  FM filter is 15 kHz.
	 * We are not supporting the 'FSK' (RTTY) mode at this time.
	 */
.filters = 	{
		{RIG_MODE_SSB|RIG_MODE_CW, kHz(2.4)},
		{RIG_MODE_FM, kHz(15)},
		RIG_FLT_END,
	},
.cfgparams =  icom_cfg_params,
.set_conf =  icom_set_conf,
.get_conf =  icom_get_conf,

.priv =  (void*)&omnivip_priv_caps,
.rig_init =   icom_init,
.rig_cleanup =   icom_cleanup,

.set_freq =  icom_set_freq,
.get_freq =  icom_get_freq,
.set_mode =  icom_set_mode,
.get_mode =  icom_get_mode,
.set_vfo =  icom_set_vfo,       // icom.c has no get_vfo
.set_rit =  omni6_set_rit,
.get_rit =  omni6_get_rit,      // icom.c has no get_rit
.set_xit =  omni6_set_rit,      // xit=rit for this rig
.get_xit =  omni6_get_rit,      // (front panel controlled)
.set_ptt =  omni6_set_ptt,

.decode_event =  icom_decode_event,
.set_mem =  icom_set_mem,
.vfo_op =  icom_vfo_op,
};

/*
 * omni6_set_ptt based on icom_set_ptt
 * Assumes rig!=NULL, rig->state.priv!=NULL
 */
int omni6_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt)
{
	int retval, sc;

	sc = ptt == RIG_PTT_ON ? 0x1 : 0x2;

/*
 * Ignore ACK/NAK on this command, because in CW mode, the Omni VI
 * does not send an ACK.
 */
	retval = icom_transaction (rig, C_OMNI6_XMT, sc, NULL, 0, NULL, NULL);
	if (retval != RIG_OK)
			return retval;
	return RIG_OK;
}

/*
 * These 'rit' commands actually deal with an offset frequency.  The operator
 * must select rit on/off or xit on/off manually to apply this offset.
 * Omni VI's rit uses 9's complement for negative freq, and freqs are in units
 * of 10 Hz. on the Omni.
 * Note that Omni VI rejects rit > 9980, but takes rit >= -9990. So the
 * rit limit should be +/- 9.98 kHz.
 */

int omni6_set_rit(RIG *rig, vfo_t vfo, shortfreq_t rit)
{
	unsigned char freqbuf[MAXFRAMELEN], ackbuf[MAXFRAMELEN];
	int freq_len, ack_len=sizeof(ackbuf), retval;
    shortfreq_t rit10;

    rit10 = rit / 10;                           // 10 Hz resolution for Omni
    if (rit10 < 0) rit10 += 10000L;             // 9's compl.
    freq_len = 2;
	to_bcd(freqbuf, rit10, 2*freq_len);

	retval = icom_transaction (rig, C_SET_OFFS, -1, freqbuf, freq_len,
					ackbuf, &ack_len);
	if (retval != RIG_OK)
		return retval;
	if (ack_len != 1 || ackbuf[0] != ACK) {
		rig_debug(RIG_DEBUG_ERR,"omni6_set_rit: ack NG (%#.2x), "
					"len=%d\n", ackbuf[0],ack_len);
		return -RIG_ERJCTED;
	}
	return RIG_OK;
}

/*
 * Note: icom.c does not provide a get_rit method. It would have been
 * wrong for the Omni VI, anyway, so we implement it here.
 */

int omni6_get_rit(RIG *rig, vfo_t vfo, shortfreq_t *rit)
{
    unsigned char buffer[MAXFRAMELEN];
    int buffer_len, retval;
    shortfreq_t my_rit;

    retval = icom_transaction (rig, C_RD_OFFS, -1, NULL, 0,
                    buffer, & buffer_len);
    if (retval != RIG_OK)
        return retval;
    if (buffer_len != 3) {
        rig_debug(RIG_DEBUG_ERR,"omni6_get_rit: wrong length response (%d)\n",
            buffer_len);
        return -RIG_ERJCTED;
    }
    my_rit = 10*from_bcd(buffer, 2*buffer_len);
    if (my_rit > 10000L) my_rit -= 100000L;     // 9's compl for negatives
    *rit = my_rit;
    return RIG_OK;
}
